home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / cnet / adddescript_11.lha / AddDescript.doc < prev    next >
Text File  |  1994-10-28  |  13KB  |  302 lines
  1.                             ADD DESCRIPT V1.1
  2.                             -----------------
  3.  
  4.                    Written by Ray Akey (AKA Heavy Metal)
  5.                          Distributed by MetalSoft
  6.                        Written for CNet Amiga v2.96+
  7.  
  8. Changes v1.1
  9. -------------
  10.    *  FILE_ID.DIZ support added - READ ENTIRE VERSION 1.1 CHANGES info!!
  11.  
  12.    1. AddDescript has been made fully MULTI-PORT compatible and relies on
  13.       environment variables to control it's port activity.  "ENV:" must be
  14.       assigned, as should "T:" if you do not specify a WORKDIR in
  15.       SYSDATA:ADDDESCRIPT.CFG.
  16.  
  17.    2. Added FILE-ID.DIZ support.
  18.       Using the <DIZ> keyword overrides LONG, SHORT and EXT keywords.
  19.       AddDescript will decide whether to add to the SHORT or LONG
  20.       (response 0) description based on your "SHORTLEN" setting in the
  21.       configuration file.  Any file_id.diz file containing more than SHORTLEN
  22.       characters will be treated as a LONG description, otherwise, it will be
  23.       added as a SHORT description.
  24.       Packer types and their associated decompression commands are located
  25.       in sysdata:AddDescript.cfg, as is the temporary WORKDIR setting.  If
  26.       a "WORKDIR" is specified, AddDescript will use that directory as it's
  27.       processing directory for decompression, etc,..
  28.       If using the <DIZ> keyword, you MUST have "sysdata:AddDescript.cfg"
  29.       configured to your system specifics as noted in that file. A typical
  30.       command string in your xscript (ie. xlha2lha - sample enclosed in this
  31.       package) would be:
  32.  
  33.               ;Add FILE-ID.DIZ as descript if existent.
  34.               runback pfiles:adddescript DIZ UDBase0: {PATHF}
  35.  
  36.       NOTE: To use in scripts converting to different compression types
  37.             (ie. xzip2lha), the {PATHF} in the above example should be
  38.             replaced with {NEWN} .
  39.   
  40.       ALSO: for some reason CNet won't let AddDescript alter the SHORT
  41.             response unless AddDescript is RUNBACK'd.  I'm sure there will be
  42.             a fix for this once I find out if CNet is indeed keeping a "LOCK"
  43.             on the short descriptions, which I hope Ken Pletzer will remove.
  44.             As long as RUNBACK is used for AddDescript when working with DIZ
  45.             files, the process is flawless.  This doesn't seem to be a problem
  46.             unless the <DIZ> option is enabled.  Also note that since
  47.             runback is used, your TRANSFORM will NOT be completed when CNet
  48.             says it is.  You must give AddDescript time to process
  49.             FILE_ID.DIZ and add it to the short description.  Go on about
  50.             your business, the process is flawless provided the same file is
  51.             not transformed twice at the SAME TIME (which is impossible if
  52.             CNet's "already transformed" protection is in working order).
  53.  
  54.  
  55.  
  56. Changes v1.03
  57. -------------
  58. 1. Fixed small bug with the default ".txt" extension.
  59.  
  60. Changes v1.02
  61. -------------
  62. 1. Added FIRST keyword.
  63.  
  64.    Using the FIRST keyword causes the textfile to always REPLACE the FIRST
  65.    response regardless of how many responses are present.
  66.  
  67. 2. Added the DESC keyword.
  68.  
  69.    Using the DESC keyword causes the argument supplied to be used as the
  70.    DESC filename.
  71.  
  72.        ie.  AddDescript DESC ram:my.txt DIR UDBase0:filestuff udbase1:files/MyFile.lha
  73.  
  74.        This example will take the file "ram:My.txt" and add its text as the
  75.        first response to the item "MyFile.lha" in your "Files" subboard whos
  76.        DATA directory is in "UDBase0:filestuff".
  77.  
  78. 3. Added the DEV keyword.
  79.  
  80.    Using the DEV keyword causes the argument supplied to be used as the
  81.    VOLUME part of the directory/path for the DATA directory files
  82.    _items3, _Text, etc,...
  83.  
  84.  
  85.        ie.  AddDescript LONG FIRST EXT .tic  DEV UDBase0: udbase1:files/MyFile.lha
  86.                                                  |     |  |     |
  87.                                                   -----    -----
  88.                                                     |        |
  89.                                                volume        original
  90.                                           replacement        volume
  91.  
  92.        This example will take the file "UDBase1:files/MyFile.tic" and add its
  93.        text as the first response to the item "UDBase1:files/MyFile.lha" whos
  94.        DATA directory is in "UDBase0:files".
  95.  
  96.  
  97. 4. Added the DEL keyword.
  98.  
  99.    Using the DEL keyword causes the DESCRIPTION file (the text file)
  100.    to be deleted after adding it to the response.
  101.  
  102.  
  103.  
  104. Changes v1.01
  105. -------------
  106. 1. Added SHORT and LONG keywords.
  107.  
  108.    SHORT:  Using the SHORT keyword cases the text file to be added to the
  109.            item's short description.
  110.  
  111.     LONG:   The opposite of the SHORT keyword.  Causes the text file to be
  112.            added to the LONG description (still replaces the last reponse
  113.            made).
  114.  
  115.     DEFAULT is "LONG"
  116.  
  117.     100% Tested with "RR" and no problems whatsoever!
  118.  
  119. ** NOTE:  When adding text using the SHORT keyword, you must exit and
  120.           re-enter the subboard to see any changes made.  This is not
  121.           a problem with the LONG keyword.
  122.  
  123.           ie.  Go into aother sub (or main) and then enter the sub where text
  124.                was added to an item.
  125.  
  126.  
  127.  
  128. What is it?
  129. -----------
  130.    AddDescript is a program that will add a text file to the long or short
  131. description of a file being adopted, transformed or uploaded.
  132.  
  133.    It was mainly created at the request of Gregory Hopkins for the purpose
  134. of using it in a .TIC-type transformation script.
  135.  
  136.    It can be used at any time.  See the NOTE below though.
  137.  
  138.    NOTE: If ANY responses exist to the item the text is being added to, the
  139.          LAST existing response will be replaced with the text in the "DESC"
  140.          file.  For this reason, AddDescript should be used IMMEDIATELY after
  141.          a file has been uploaded or adopted.
  142.  
  143.  
  144.  
  145. SYNTAX/ARGUMENTS
  146. ----------------
  147. AddDescript accepts quite a few arguments as follows:
  148.  
  149. 1.    <POSTNAME>
  150.  
  151.       MUST EXIST - This is the filename/itemname that your text file will be
  152.                    added to.  If a path is present, it will be used unless
  153.                    a [DIR] specifier/argument is used.
  154.  
  155.          EXAMPLE:   AddDescript MyFile.lha
  156.  
  157.  
  158. 2.    [EXT <EXTENSION>]
  159.  
  160.       Optional - If existent, the text file to be assumed to have this
  161.                  extension.  If no EXT is specified, ".txt" is assumed as
  162.                  default.
  163.  
  164.          ie.  AddDescript EXT .tic MyFile.lha
  165.  
  166.          This would cause the description file "MyFile.tic" to be searched for
  167.          and added to the Item/post  "MyFile.lha".
  168.  
  169.  
  170. 3. [DIR <DataDir>]
  171.  
  172.       Optional - The DataDir is the directory where your SUBBOARD "DATA"
  173.                  directory exists.
  174.  
  175.                  This argument should be used if you use more than one
  176.                  UDBase partition.
  177.  
  178.                  If not existent, the DIR to be used will be extracted from
  179.                  the argument passed as "PostName".  If no drive/path is
  180.                  present in the post name, the current directory will be
  181.                  assumed.
  182.  
  183.          ie.  AddDescript EXT .tic DIR UDBase0:files udbase1:files/MyFile.lha
  184.  
  185.                This causes the text file "UDBASE1:files/MyFile.tic" to be
  186.                added to the description of the item "MyFile.lha", who's data
  187.                files exist in "UDBASE0:files/data"
  188.  
  189. 4. SHORT:  Using the SHORT keyword cases the text file to be added to the
  190.            item's short description.
  191.  
  192. 5.    LONG:   The opposite of the SHORT keyword.  Causes the text file to be
  193.            added to the LONG description (still replaces the last reponse
  194.            made).
  195.  
  196.            DEFAULT is "LONG"
  197.  
  198. 6  FIRST:  Using the FIRST keyword causes the textfile to always REPLACE the
  199.            FIRST response regardless of how many responses are present.
  200.  
  201. 7. DESC:   Using the DESC keyword causes the argument supplied to be used as
  202.            the DESC filename.
  203.  
  204.        ie.  AddDescript DESC ram:my.txt DIR UDBase0:filestuff udbase1:files/MyFile.lha
  205.  
  206.        This example will take the file "ram:My.txt" and add its text as the
  207.        first response to the item "MyFile.lha" in your "Files" subboard whos
  208.        DATA directory is in "UDBase0:filestuff".
  209.  
  210. 8. DEV:    Using the DEV keyword causes the argument supplied to be used as
  211.            the VOLUME part of the directory/path for the DATA directory files
  212.            _items3, _Text, etc,...
  213.  
  214.  
  215.        ie.  AddDescript LONG FIRST EXT .tic  DEV UDBase0: udbase1:files/MyFile.lha
  216.                                                  |     |  |     |
  217.                                                   -----    -----
  218.                                                     |        |
  219.                                                volume        original
  220.                                           replacement        volume
  221.  
  222.        This example will take the file "UDBase1:files/MyFile.tic" and add its
  223.        text as the first response to the item "UDBase1:files/MyFile.lha" whos
  224.        DATA directory is in "UDBase0:files".
  225.  
  226.  
  227. 9. DEL:    Using the DEL keyword causes the DESCRIPTION file (the text file)
  228.            to be deleted after adding it to the response.
  229.  
  230. 10. DIZ:   Using the <DIZ> keyword overrides LONG, SHORT and EXT keywords.
  231.            AddDescript will decide whether to add to the SHORT or LONG
  232.            (response 0) description based on your "SHORTLEN" setting in the
  233.            configuration file.  Any file_id.diz file containing more than
  234.            SHORTLEN characters will be treated as a LONG description,
  235.            otherwise, it will be added as a SHORT description. Packer types
  236.            and their associated decompression commands are located in
  237.            sysdata:AddDescript.cfg, as is the temporary WORKDIR setting.  If
  238.            a "WORKDIR" is specified, AddDescript will use that directory as
  239.            it's processing directory for decompression, etc,..  If using the
  240.            <DIZ> keyword, you MUST have "sysdata:AddDescript.cfg" configured
  241.            to your system specifics as noted in that file. A typical command
  242.            string in your xscript (ie. xlha2lha - sample enclosed in this
  243.            package) would be:
  244.  
  245.               ;sample line from example xscript 
  246.               runback pfiles:adddescript DIZ UDBase0: {PATHF}
  247.  
  248.       NOTE: To use in scripts converting to different compression types
  249.             (ie. xzip2lha), the {PATHF} in the above example should be
  250.             replaced with {NEWN} .
  251.   
  252.       BUG:  for some reason CNet won't let AddDescript alter the SHORT
  253.             response unless AddDescript is RUNBACK'd.  I'm sure there will be
  254.             a fix for this once I find out if CNet is indeed keeping a "LOCK"
  255.             on the short descriptions, which I hope Ken Pletzer will remove.
  256.             As long as RUNBACK is used for AddDescript when working with DIZ
  257.             files, the process is flawless.  This doesn't seem to be a problem
  258.             unless the <DIZ> option is enabled.  Also note that since
  259.             runback is used, your TRANSFORM will NOT be completed when CNet
  260.             says it is.  You must give AddDescript time to process
  261.             FILE_ID.DIZ and add it to the short description.  Go on about
  262.             your business, the process is flawless provided the same file is
  263.             not transformed twice at the SAME TIME (which is impossible if
  264.             CNet's "already transformed" protection is in working order).
  265.  
  266.  
  267.  
  268.  
  269. INSTALLATION
  270. ------------
  271.    There are several ways in which this utility can be used, but the most
  272. obvious one - and the only one I will deal with here - is to use it in a CNet
  273. "XSCRIPT" as follows:
  274.  
  275.    An xlha2lha script is included in this package and will be used as an
  276.    example below:
  277.  
  278.                AddDescript DIR UDBase0:files EXT .tic {NEWN}
  279.  
  280.          UDBase0:files -is where all the /DATA directories exist (default)
  281.          .tic          -is the extension that all description files will have.
  282.          {NEWN}        -is the title (including path) that CNet passes as the
  283.                        -transformed item's filename.
  284.  
  285.  
  286.  
  287. Disclaimer
  288. ----------
  289.    I'm sure this will be a VERY useful utility to many CNet BBS' involved
  290. in networking.  I make no claims that it will be easy to install as it
  291. is a utility that only experienced CNet SysOps will use anyway.
  292.  
  293.    For this reason, I present it as a gift to ALL CNET SYSOPS
  294. as FREEWARE.  Please let me know if you use this utility so I may continue
  295. development.
  296.  
  297.    Also, Please feel free to distribute this product through the networks
  298. and/or in any disk compilations you know of, such as Fish, etc,..
  299.  
  300.  
  301. --- Ray Akey/Heavy Metal - MetalSoft
  302.